Skip to content

tiup: document Prometheus external labels in Chinese - #21837

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
zanmato1984:codex/tiup-external-labels-docs-cn
Jul 29, 2026
Merged

tiup: document Prometheus external labels in Chinese#21837
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
zanmato1984:codex/tiup-external-labels-docs-cn

Conversation

@zanmato1984

@zanmato1984 zanmato1984 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

This PR adds the Chinese documentation for TiUP support for monitoring_servers[].external_labels.

It mirrors the English docs update by documenting the new field in the TiUP cluster and DM topology references, and by adding a dedicated section to the monitoring customization guide. It also keeps the compatibility note aligned with the implementation: older TiUP versions fail to parse the topology file instead of ignoring the field.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • 文档
    • 新增 Prometheus 自定义外部标签(external_labels)配置说明。
    • 补充 environmentregion 等配置示例。
    • 说明标签命名限制及 clustermonitor 保留标签约束。
    • 明确该配置需 TiUP v1.17.0 及以上版本支持,旧版本解析时可能失败。

@ti-chi-bot

ti-chi-bot Bot commented Jul 26, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 26, 2026
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

新增 TiUP v1.17.0 起的 Prometheus external_labels 配置文档,覆盖自定义指南、集群拓扑参考和 DM 拓扑参考,并说明标签限制、示例及旧版 TiUP 的解析失败行为。

Changes

Prometheus external labels 文档

Layer / File(s) Summary
自定义配置说明
tiup/customized-montior-in-tiup-environment.md
新增 monitoring_servers.external_labels 的配置入口、YAML 示例、标签命名限制及版本兼容性说明。
集群与 DM 拓扑参考
tiup/tiup-cluster-topology-reference.md, tiup/tiup-dm-topology-reference.md
在字段说明和配置示例中补充 external_labelsenvironmentregion,并说明保留标签、命名规则及旧版解析失败行为。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: missing-translation-status

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed 标题准确概括了本次变更:为 TiUP 的 Prometheus external labels 提供中文文档说明。
Description check ✅ Passed 描述覆盖了必填变更说明、影响版本、相关链接、AI 参与情况及其他检查项。
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jul 26, 2026
@zanmato1984 zanmato1984 added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jul 26, 2026
@ti-chi-bot ti-chi-bot Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 26, 2026
@zanmato1984
zanmato1984 marked this pull request as ready for review July 26, 2026 23:30
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 26, 2026
@lilin90 lilin90 added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jul 27, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 27, 2026
@lilin90 lilin90 self-assigned this Jul 27, 2026
@lilin90 lilin90 added translation/from-docs This PR is translated from a PR in pingcap/docs. and removed translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. labels Jul 27, 2026
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/customized-montior-in-tiup-environment.md Outdated
Comment thread tiup/tiup-cluster-topology-reference.md Outdated
Comment thread tiup/tiup-dm-topology-reference.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-07-27 03:55:47.604511323 +0000 UTC m=+1809133.640606369: ☑️ agreed by lilin90.

@lilin90

lilin90 commented Jul 28, 2026

Copy link
Copy Markdown
Member

/hold

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 28, 2026
@lilin90 lilin90 added area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. for-release This PR relates to a TiDB release but does not have a tracked feature. lgtm and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jul 29, 2026

@lilin90 lilin90 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@ti-chi-bot

ti-chi-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Jul 29, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 4da42c4 into pingcap:master Jul 29, 2026
11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #21844.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. for-release This PR relates to a TiDB release but does not have a tracked feature. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants